home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / gfx / conv / iff2source.zoo / Iff2Source / Iff2Src.doc < prev    next >
Text File  |  1990-12-04  |  9KB  |  185 lines
  1. ==============================================================================
  2.  
  3.         Iff 2 Source                    V1.0
  4.         © J.Tyberghein                  Mon Oct  8 09:02:11 1990
  5.  
  6. ==============================================================================
  7.  
  8.  
  9.  
  10. Preface
  11. -------
  12.   This utility converts IFF ILBM or ANIM files to C or machinelanguage
  13.   source. You can of course use this source in your own programs (with
  14.   the intuition function DrawImage).
  15.  
  16.   This program (IFF2SRC V1.0) is public domain but contributions and some
  17.   utilities are always welcome.
  18.   If you want to use this program for commercial purposes please write
  19.   for permission !
  20.  
  21.   If you have any suggestions or remarks you can write to (Bug reports are
  22.   welcome too)
  23.  
  24.                             Jorrit  Tyberghein
  25.                              Hepmansbossen 31
  26.                            2450 Meerhout BELGIUM
  27.  
  28.  
  29. WARNING
  30. -------
  31.   If you want to use this utility you must have AmigaDOS 2.0 (or later :-).
  32.   IFF2SRC is a workbench program but you can start it from CLI if you want.
  33.  
  34.  
  35. Usage
  36. -----
  37.   Double click on the IFF2SRC icon. If all goes well you should get the
  38.   IFF2SRC main window. You can drag and iconify this window with the usual
  39.   gadgets.
  40.  
  41.   What do you see ?
  42.  
  43.     In the topleft corner we have the 'Selected files' list. At this moment
  44.     it is probably empty. In this list are all the IFF files that you want
  45.     to convert to source. This is one of the nice features of this program:
  46.     You can select a lot of files and convert them all at once.
  47.     Files starting with an asterix ('*') are files that are excluded from
  48.     processing. This means that these files will not be converted to source
  49.     when you press 'Start' (the button to start converting). Files are
  50.     automatically excluded when they are converted with success.
  51.     You can exclude and include files by clicking on the name of the file
  52.     in this list (The asterix will toggle). (Selected files are also called
  53.     'marked files')
  54.     The file list is sorted by name.
  55.  
  56.     Below the text 'Add file' is the string gadget used to add a file to
  57.     the 'Selected files' list. You can use wildcards in this gadget. If,
  58.     for example, you type 'sys:graphics/#?', all files in the
  59.     subdirectory graphics will be added to the file list. This is the first
  60.     method to add files to the file list.
  61.     (Note that .info files are not added to the file list).
  62.  
  63.     Under the 'Add file' gadget is the 'Destination dir' gadget. If you
  64.     press 'Start', all files will be converted to this directory. They will
  65.     get the '.C' or '.ASM' extension.
  66.     If this stringgadget is empty (default), all files are converted to the
  67.     current directory.
  68.  
  69.     Below this gadget are two cycle gadgets. With the 'Tabs' cycle gadget
  70.     you can set the tab size for the generated source. You can choose
  71.     between: 1 tab (in my editor tabs are equivalent to 2 spaces),
  72.     2 tabs (this is the default), 2 spaces or 4 spaces for each line.
  73.     With the 'Source' cycle gadget you can choose between C or
  74.     machinelanguage.
  75.  
  76.     With the 'Compress' checkbox you can enable data compressing. This is
  77.     not very spectacular. Instead of writing everything in hexadecimal,
  78.     everything is written in decimal. This decreases the output source
  79.     file size.
  80.  
  81.     To the right in this window are 8 buttons:
  82.       - 'Add'
  83.           This is the second way to add a file to the file list.
  84.           When you press this button you get the standard file requester.
  85.           You can select your file in this requester. When you have done
  86.           this, the file will appear in the file list.
  87.           Maybe a strange feature, but you can also use wildcards in this
  88.           filerequester: When you are walking through the subdirectories
  89.           you can suddenly decide that you want to convert all files in
  90.           the current directory. Simple type '#?' in the filename gadget,
  91.           and all files will be added.
  92.       - 'Info'
  93.           This button gives you information for all files that are not
  94.           excluded (are not marked with a '*'). The 'info' window is
  95.           explained below.
  96.       - 'Start'
  97.           This button actually does it. All files that are not excluded are
  98.           converted to C or assembler. Don't forget to set your destination
  99.           directory. If the 'Destination dir' gadget is empty, all files
  100.           will be converted to the current directory.
  101.           Note that IFF2SRC will convert IFF ILBM files with a BMHD and a
  102.           BODY chunk. If there is a CMAP chunk, IFF2SRC will use it to
  103.           generate some extra source (the ColorMap).
  104.           If the IFF file is an ANIM, IFF2SRC will convert the first
  105.           picture in this ANIM file.
  106.           IFF2SRC correctly interpretes masks (like stencils from DPaint)
  107.           and writes source for it as well.
  108.       - 'Mark'
  109.           This button marks all files. All files in the 'selected file
  110.           list' are then excluded and will not take part in actions like
  111.           'Start' and 'Info'.
  112.       - 'Unmark'
  113.           This button unmarks (includes) all files.
  114.       - 'Clr mrk' (Clear marked)
  115.           This button removes all files (from the file list) that are
  116.           marked.
  117.       - 'Clear'
  118.           This button removes all files from the file list.
  119.       - 'Abort'
  120.           This button is ghosted (unavailable) by default. When you select
  121.           an action (like 'Start','Info','Add',...) you can abort the
  122.           action with this button.
  123.           Note that if you try to abort the converting action ('Start'),
  124.           IFF2SRC will first continue the current file before aborting.
  125.  
  126.     There is still a third way to add files to the file list:
  127.     You can select a bunch of icons and drop them into the IFF2SRC main
  128.     window.
  129.  
  130.  
  131.   When you have choosen 'Info' in the main window, you get the following
  132.   'Info Window' window for each not-excluded file:
  133.  
  134.   What do you see ?
  135.  
  136.     Information like the filename and path. The Width, Height and
  137.     Depth (number of planes) of the image.
  138.  
  139.     At the right of this window you can see a small version of the IFF file.
  140.     Because the workbench only has 2 bitplanes (by default), you only see
  141.     two bitplanes of this picture. You can choose the bitplanes that you
  142.     want to see with the cycle gadgets above the 'Stop' and 'Okay' gadgets.
  143.     There are as many cycle gadgets as there are bitplanes in the workbench
  144.     (if you select more bitplanes with preferences you will get more cycle
  145.     gadgets). However, if the picture has less bitplanes than the
  146.     workbench, you will see as many cycle gadgets as there are bitplanes
  147.     in the picture.
  148.     Thus, one cycle gadget corresponds with one bitplane for the workbench.
  149.     Each cycle gadget can have values between 0 and the number of picture
  150.     bitplanes minus one. For example, if the first cycle gadget has value 3
  151.     and the second cycle gadget has value 2, then bitplane 3 and bitplane 2
  152.     from the picture are copied to the workbench bitplanes 0 and 1.
  153.     You can increase the values for these cycle gadget by clicking on them.
  154.     To decrease the values press shift and click on them.
  155.     If you are not sure that you understand this rather clumsy explanation
  156.     you can experiment with 'TestBrush'. This brush is so constructed that
  157.     you can always read which planes are on.
  158.  
  159.     'Stop' gadget. When you press this gadget 'Info' will be aborted. He
  160.     will not even go to the next file. It is equivalent to pressing 'Abort'
  161.     in the main window and pressing 'Okay' in this window, but this is
  162.     rather clumsy.
  163.  
  164.     'Okay' gadget. Use this button when you have seen the information and
  165.     you want to go to the next not-excluded file (if there is one).
  166.  
  167.  
  168.   Requesters.
  169.  
  170.     When something goes wrong you get a requester. Some requesters only
  171.     have one gadget. You have no choice but to press that gadget.
  172.     There are requesters, however, with two gadgets: 'Stop' and 'Continue'.
  173.     These requesters can occur after you press the 'Start' or the 'Info'
  174.     button. Pressing 'Stop' causes the current action to completely abort
  175.     (just like the 'Stop' button in the 'Info window'). If you press
  176.     'Continue', IFF2SRC will stop processing the current file and proceed
  177.     with the next not-excluded file.
  178.  
  179.  
  180. ==============================================================================
  181.  
  182.                         End of IFF2SRC 1.0 document
  183.  
  184. ==============================================================================
  185.